Openfisca 渋谷区子育て支援制度版開発環境構築・開発方法

開発環境構築

yuiseki.iconさんが整備された環境を十分に理解せずにfuruhashi.iconが以下記載しているので、非推奨の方法になっているかもしれません。Windows環境は動作確認できていません。皆さん適宜修正してください。

github

githubの個人アカウントを作成する。

githubアカウント作成方法

proje-inclusiveのgithubリポジトリを個人アカウントのリポジトリとしてフォークし、ローカル環境（自分のPC）にクローン（ダウンロード）する。

Koichiro Shiratori.iconさん、proj-inclusiveのgithubリポジトリリンクの貼り付けお願いします。

フォーク・クローンの流れ

リポジトリをクローンはGithub desktop, Source treeなどのツールを使うのが簡単。

Docker

テストコードを作成・実行するだけなら、自分のPCでDocker環境を作らずともGithub CodeSpace上で可能？

自分のPCのDocker環境でコーディング・実行できた方が操作性が良いため、以下にその方法をメモ　　

Docker Desktopをインストールして起動する。

Windowsの場合：WindowsでのDocker Desktop環境構築

Macの場合：MacでのDocker Desktop環境構築

自分のPC上のOpenfisca-ShibuyaのルートディレクトリでWindowsならPowershell、MacならTerminalを開く。

code: フロントエンド・バックエンドを一括で環境構築・起動

# docker環境を構築・起動

docker-compose up --build

# 「Ctrlキー＋c」でdocker環境を停止

# バックエンド・フロントエンドをそれぞれ以下のように単独で起動する場合は、下のコマンドで一括起動を終了する。

docker-compose down

code: バックエンドのみ環境構築・起動

# docker環境を構築

docker build ./ -t openfisca_japan

# docker環境を起動

docker run -it --rm -p 50000:50000 -v "$(pwd):/app" -u user openfisca_japan

# $(pwd)はDockerfileが存在するディレクトリの絶対パスで置き換える必要があるかもしれない。

# docker環境を終了

exit

code: フロントエンドのみ環境構築・起動

# dashboardのディレクトリに移動

cd dashboard

# docker環境を構築

docker build ./ -t openfisca_japan_dashboard

# docker環境を起動

docker run -it --rm -p 30000:30000 -v "$(pwd)/src:/app/src" -u user openfisca_japan_dashboard

# docker環境を終了

exit

# 元のディレクトリに戻る

cd ..

開発方法

yuiseki.iconさんが整備された環境を十分に理解せずにfuruhashi.iconが以下記載しているので、非推奨の方法になっているかもしれません。皆さん適宜修正してください。

事前準備

Github CodeSpace或いは自分のPCでdocker環境に入って、make コマンドを実行した状態にする。

テスト

code:全てのテストを実行

make test

code:一部のテストを実行

openfisca test --country-package openfisca_japan openfisca_japan/tests/実行したいテストファイル或いはディレクトリパス

テストファイル（~.yaml）は変更しても、上のコマンドで実行するときに反映される。

内部計算方法の修正

variables/~.py等の計算方法を規定するファイルを修正する。

以下のビルドを行わないとテスト時に修正が反映されない。

code:pythonファイルのビルド

make build

上述のテストを行う。

Githubにissueを立てて、ブランチを切り、修正できたらプルリクエストを出してmainブランチにマージする。